home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / mig / sprite / RCS / mig.1,v < prev    next >
Encoding:
Text File  |  1991-05-24  |  3.0 KB  |  140 lines
  1. head     1.2;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.2
  10. date     91.05.23.22.58.24;  author kupfer;  state Exp;
  11. branches ;
  12. next     1.1;
  13.  
  14. 1.1
  15. date     91.05.23.22.56.29;  author kupfer;  state Exp;
  16. branches ;
  17. next     ;
  18.  
  19.  
  20. desc
  21. @man page for mig.
  22. @
  23.  
  24.  
  25. 1.2
  26. log
  27. @Minimal cleanup for Sprite.
  28. @
  29. text
  30. @.TH  MIG  1 1/19/87
  31. .CM 4
  32. .SH NAME
  33. mig \- Mach message interface generator
  34. .SH SYNOPSIS
  35. .B mig [-qQvVrRtT] [-user <name>] [-server <name>] 
  36. .B [-header <name>]
  37. definitions-file
  38.  
  39. .SH DESCRIPTION
  40. .I mig(1)
  41. uses the interface definitions in the definitions-file and creates two c
  42. modules: subsystemUser.c and subsystemServer.c. These modules
  43. implement respectively the user and the server ends of a
  44. remote procedure call interface to the subsystem. A header file
  45. subsystem.h is also generated that defines the external
  46. functions and can be included in any code using the user
  47. interface.
  48.  
  49. The switches are:
  50. .TP
  51. .I -r,-R
  52. If r, use msg_rpc, if R use msg_send, msg_receive pairs. The default is
  53. .I r.
  54. .TP
  55. .I -q,-Q
  56. If -q, warning statements will be suppressed. If -Q warning statements
  57. are printed. The default is
  58. .I Q.
  59. .TP
  60. .I -v,-V
  61. If v, all the types, routines and arguments are printed out as
  62. they are encountered. If V, the compilation is silent. The
  63. default is
  64. .I V.
  65. .TP
  66. .I -s,-S
  67. If s, a symbol table of rpc-name, number, routine triplets is generated
  68. in the server file.  If S, the symbol table is not generated. The default
  69. is
  70. .I S.
  71. .TP
  72. .I -i
  73. If this switch is specified, each user routine is put in its own file,
  74. for ease in building a library.  The file name is <routine_name>.c.
  75. If this
  76. switch is not specified (the default), all of the user routines are
  77. put in the same file.
  78. .TP
  79. .I -user <name>
  80. Name the user file <name>.  If not specified, the user file is named
  81. <subsystem>User.c.
  82. .TP
  83. .I -server <name>
  84. Name the server file <name>.  If not specified, the server file is named
  85. <subsystem>Server.c.
  86. .TP
  87. .I -header <name>
  88. Name the header file <name>.  If not specified, the server file is named
  89. <subsystem>.h.
  90. .i0
  91. .DT
  92.  
  93. .SH FILES
  94. /sprite/lib/include.mach/mig_errors.h \- error codes generated by mig code
  95. .br
  96. subsystemUser.c \- the code for the user side of the interface
  97. .br
  98. subsystem.h \- the include file for the user routines
  99. .br
  100. subsystemServer.c \- the code for the server side of the interface
  101.  
  102. .SH HISTORY
  103. .TP
  104. 8-Feb-88   David B. Golub (dbg)
  105. Updated document to reflect new switches.
  106.  
  107. .TP
  108. 21-Jul-87  Mary R. Thompson (mrt)
  109. Updated document to reflect new switches.
  110.  
  111. .TP
  112. 2-Mar-87   Mary R. Thompson (mrt)
  113. Updated document to reflect -q switch and new name for the syntax 
  114. definitions file.
  115.  
  116. .TP
  117. 20-Aug-86  Mary R. Thompson (mrt)
  118. Created man page. mig was created by Michael W. Young from
  119. the Spice Matchmaker program
  120.  
  121. @
  122.  
  123.  
  124. 1.1
  125. log
  126. @Initial revision
  127. @
  128. text
  129. @d65 1
  130. a65 1
  131. /usr/mach/include/mig_errors.h \- error codes generated by mig code
  132. d71 1
  133. a71 5
  134. subsystemServer.h \- the code for the server side of the interface
  135.  
  136. .SH "SEE ALSO"
  137. /usr/mach/doc/mig.PS \- manual that defines the syntax
  138. of the definitions file.
  139. @
  140.